package com.zhanghw.shop.data.notes;

/**
 * 用户 controller swagger注释
 *
 * @author 张浩伟
 * @date 2018/11/20
 */
public class UserNotes {

    public static final String LIST_NOTE = "用户列表，入参如下\n" +
            "\n" +
            "```\n" +
            "{\n" +
            "    \"pageNo\": \"当前页\",\n" +
            "    \"pageSize\": \"每页记录条数\",\n" +
            "    \"orderColumn\": \"排序列(非必填)\",\n" +
            "    \"orderSort\": \"排序方法[asc:正序，desc:倒序],默认倒序\",\n" +
            "    \"username\": \"用户名\",\n" +
            "    \"password\": \"密码\",\n" +
            "    \"createTime\": \"创建时间\",\n" +
            "    \"updateTime\": \"更新时间\",\n" +
            "    \"deleted\": \"状态(0:正常,1:删除)\"\n" +
            "}\n" +
            "```";


    public static final String LIST_VALUE = "\n" +
            "\n" +
            "```\n" +
            "{\n" +
            "    \"pageNo\": 1,\n" +
            "    \"pageSize\": 10,\n" +
            "    \"username\": \"用户名\",\n" +
            "    \"password\": \"密码\",\n" +
            "    \"createTime\": \"创建时间\",\n" +
            "    \"updateTime\": \"更新时间\",\n" +
            "    \"deleted\": \"状态(0:正常,1:删除)\"\n" +
            "}\n" +
            "```";

    public static final String ADD_NOTE = "用户，入参如下\n" +
            "\n" +
            "```\n" +
            "{\n" +
            "    \"username\": \"用户名\",\n" +
            "    \"password\": \"密码\",\n" +
            "    \"deleted\": \"状态(0:正常,1:删除)\"\n" +
            "}\n" +
            "```";

    public static final String ADD_VALUE = "\n" +
            "\n" +
            "```\n" +
            "{\n" +
            "    \"username\": \"用户名\",\n" +
            "    \"password\": \"密码\",\n" +
            "    \"deleted\": \"状态(0:正常,1:删除)\"\n" +
            "}\n" +
            "```";

    public static final String EDIT_NOTE = "用户修改，入参如下\n" +
            "\n" +
            "```\n" +
            "{\n" +
            "    \"id\": \"主键\",\n" +
            "    \"username\": \"用户名\",\n" +
            "    \"password\": \"密码\",\n" +
            "    \"deleted\": \"状态(0:正常,1:删除)\"\n" +
            "}\n" +
            "```";

    public static final String EDIT_VALUE = "\n" +
            "\n" +
            "```\n" +
            "{\n" +
            "    \"id\": \"主键\",\n" +
            "    \"username\": \"用户名\",\n" +
            "    \"password\": \"密码\",\n" +
            "    \"deleted\": \"状态(0:正常,1:删除)\"\n" +
            "}\n" +
            "```";

}
